package com.aiwiown.face.domain.params;

/**
 * <pre>
 * </pre>
 * FaceImageType
 * Date: 2020/5/25 0025
 * Time: 16:46
 *
 * @author tang.xiaosheng@qq.com
 */
public enum FaceImageType implements ApiEnumParam {

    /**
     * 确定待比对图片的类型。取值只为“meglive”、“facetoken”、“raw_image”、“meglive_flash” 四者之一，取其他值返回错误码400（BAD_ARGUMENTS）。
     */
    MEGLIVE("meglive", "表示本次比对照为从FaceID活体检测SDK MegLive 中生成的最优照片。以下的“比对图片 四选一”参数组里，必须使用“配合MegLive SDK使用时”这一组参数，否则可能返回错误码400（MISSING_ARGUMENTS）。"),
    FACE_TOKEN("facetoken", "表示本次比对时，用户已经调用了FaceID的detect方法从原始图片中检测出人脸，用一个facetoken表示，然后将这个facetoken作为待比对的人脸。以下的“比对图片 四选一””参数组里，必须使用“调用detect后获得facetoken时”这一组参数，否则可能返回错误码400（MISSING_ARGUMENTS）。"),
    RAW_IMAGE("raw_image", "表示本次比对时，用户直接上传一张可能包含人脸的图片作为待比对的图片，FaceID将先检测图中人脸然后将人脸与参照脸比对。以下的“比对图片 四选一””参数组里，必须使用“直接上传一张照片时”这一组参数，否则可能返回错误码400（MISSING_ARGUMENTS）"),
    MEGLIVE_FLASH("meglive_flash", "表示本次比对的照片为从 FaceID 炫彩活体 SDK MegLiveFlash 中生成的照片。以下的“四选一”参数组里，必须使用“配合MegLiveFlash SDK使用时”这一组参数，否则可能返回错误码400（MISSING_ARGUMENTS）。");

    private String paramValue;
    private String paramExplain;

    FaceImageType(String paramValue, String paramExplain) {
        this.paramValue = paramValue;
        this.paramExplain = paramExplain;
    }

    @Override
    public String getParamValue() {
        return this.paramValue;
    }

    @Override
    public String getParamExplain() {
        return this.paramExplain;
    }
}
